Skip to main content
Version: 2.0

Campaign Tags

  • API Endpoints: - /v2/wa/messages
  • Authentication: - This API requires Bearer token authentication.
  • Method: - POST
  • Payload: - The payload must be passed in the body as a JSON object. It should include a metadata object containing tags. The campaign and template tags are optional and may be included either individually or together, based on the request.

Expecting tags in below format inside metadata:

{
"metadata": {
"tags": {
"campaign": [],
"template": []
}
}
}
  • The campaign and template tags are optional. These can be included individually or both can be included as needed.
  • If campaign or template tags are received, they should be passed as part of the "tags" field in the payload.
  • Any campaign tags received from the Conv API must be forwarded to the platform APIs for RCS and WA.
  1. Both campaign and template tags provided:
{
"metadata": {
"tags": {
"campaign": ["campaign_tag_value1", "campaign_tag_value2", "campaign_tag_value3" ],
"template": ["template_tag_value1", "template_tag_value2"]
}
}
}
  1. When only campaign tag is provided:
{
"metadata": {
"tags": {
"campaign": ["campaign_tag_1"]
}
}
}
  1. When only template tag is provided:
{
"metadata": {
"tags": {
"template": ["template_tag_1"]
}
}
}
  • Response: On a successful request, following response is received:
{
"success": "true",
"responseId": "<responseid>"
}